FoxitPDFSDKPython3.TextObject类 参考

类 FoxitPDFSDKPython3.TextObject 继承关系图:

Public 成员函数
def	GetCharCount ()
	获取当前文本对象中的字符数量。 更多...
def	GetCharHeightByIndex (index)
	获取当前文本对象中指定索引字符的高度。 更多...
def	GetCharPos (index)
	获取当前文本对象中指定索引字符的位置。 更多...
def	GetCharWidthByIndex (index)
	获取当前文本对象中指定索引字符的宽度。 更多...
def	GetText ()
	获取文本字符串。 更多...
def	GetTextState (page)
	获取文本状态信息。 更多...
def	SetText (text)
	设置文本字符串。 更多...
def	SetTextState (page, text_state, is_italic, weight)
	设置文本状态信息。 更多...
Public 成员函数 继承自 FoxitPDFSDKPython3.GraphicsObject
def	AddClipPath (path, fill_mode)
	添加用于裁剪的路径。 更多...
def	AddClipTextObject (textobject)
	添加用于裁剪的文本对象。 更多...
def	ClearClips ()
	清除所有裁剪。 更多...
def	Clone ()
	克隆新的图形对象。 更多...
def	GetBlendMode ()
	获取透明成像模型的混合模式。 更多...
def	GetClipPath (index)
	根据索引获取路径裁剪。 更多...
def	GetClipPathCount ()
	获取路径裁剪的数量。 更多...
def	GetClipPathFillMode (index)
	根据索引获取路径裁剪的填充模式。 更多...
def	GetClipRect ()
	获取裁剪矩形。 更多...
def	GetClipTextObject (index)
	根据索引获取文本裁剪的文本对象。 更多...
def	GetClipTextObjectCount ()
	获取文本裁剪的数量。 更多...
def	GetColorState ()
	获取颜色状态。 更多...
def	GetFillColor ()
	获取填充颜色。 更多...
def	GetFillOpacity ()
	获取除描边外的绘制操作的不透明度值。 更多...
def	GetFormXObject ()
	如果当前图形对象表示表单XObject对象，则获取表单XObject图形对象。 更多...
def	GetGraphState ()
	获取图形状态。 更多...
def	GetImageObject ()
	如果当前图形对象表示图像对象，则获取图像图形对象。 更多...
def	GetLayers (layer_tree)
	获取与当前图形对象关联的所有图层。 更多...
def	GetMarkedContent ()
	获取标记内容对象。 更多...
def	GetMatrix ()
	获取矩阵。 更多...
def	GetPathObject ()
	如果当前图形对象表示路径对象，则获取路径图形对象。 更多...
def	GetRect ()
	获取当前图形对象的矩形。 更多...
def	GetShadingObject ()
	如果当前图形对象表示阴影对象，则获取阴影图形对象。 更多...
def	GetStrokeColor ()
	获取描边颜色。 更多...
def	GetStrokeOpacity ()
	获取路径和字形轮廓的描边绘制操作的不透明度值。 更多...
def	GetTextObject ()
	如果当前图形对象表示文本对象，则获取文本图形对象。 更多...
def	GetType ()
	获取当前图形对象的类型。 更多...
def	HasTransparency ()
	检查当前图形对象是否具有透明度。 更多...
def	Release ()
	释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。 更多...
def	RemoveClipPath (index)
	根据索引删除路径裁剪。 更多...
def	RemoveClipTextObject (index)
	根据索引删除用于裁剪的文本裁剪。 更多...
def	Rotate (angle)
	从当前状态以指定的角度顺时针旋转当前图形对象。 更多...
def	SetBlendMode (blend_mode)
	设置透明成像模型的混合模式。 更多...
def	SetClipRect (clip_rect)
	设置裁剪矩形。 更多...
def	SetColorState (color_state)
	设置颜色状态。 更多...
def	SetFillColor (color)
	设置填充颜色。 更多...
def	SetFillOpacity (opacity)
	设置除描边外的绘制操作的不透明度值。 更多...
def	SetGraphState (graph_state)
	设置图形状态。 更多...
def	SetMatrix (matrix)
	设置矩阵。 更多...
def	SetStrokeColor (color)
	设置描边颜色。 更多...
def	SetStrokeOpacity (opacity)
	设置路径和字形轮廓的描边绘制操作的不透明度值。 更多...
def	Transform (matrix, need_transform_clippath)
	变换当前图形对象。 更多...

静态 Public 成员函数
def	Create ()
	创建新的文本图形对象。 更多...

额外继承的成员函数
静态 Public 属性 继承自 FoxitPDFSDKPython3.GraphicsObject
	e_BlendColor = _fsdk.GraphicsObject_e_BlendColor
	使用源颜色的色调和饱和度以及背景颜色的明度创建颜色。 更多...
	e_BlendColorBurn = _fsdk.GraphicsObject_e_BlendColorBurn
	加深背景颜色以反映源颜色。 更多...
	e_BlendColorDodge = _fsdk.GraphicsObject_e_BlendColorDodge
	增亮背景颜色以反映源颜色。 更多...
	e_BlendDarken = _fsdk.GraphicsObject_e_BlendDarken
	选择背景和源颜色中较暗的一个。 更多...
	e_BlendDifference = _fsdk.GraphicsObject_e_BlendDifference
	从较亮的颜色中减去两种组成颜色中较暗的一种。 更多...
	e_BlendExclusion = _fsdk.GraphicsObject_e_BlendExclusion
	使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
	e_BlendHardlight = _fsdk.GraphicsObject_e_BlendHardlight
	根据源颜色值进行相乘或滤色。 更多...
	e_BlendHue = _fsdk.GraphicsObject_e_BlendHue
	使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
	e_BlendLighten = _fsdk.GraphicsObject_e_BlendLighten
	选择背景和源颜色中较亮的一个。 更多...
	e_BlendLuminosity = _fsdk.GraphicsObject_e_BlendLuminosity
	使用源颜色的明度和背景颜色的色调和饱和度创建颜色。 更多...
	e_BlendMultiply = _fsdk.GraphicsObject_e_BlendMultiply
	将背景与源颜色值相乘。 更多...
	e_BlendNormal = _fsdk.GraphicsObject_e_BlendNormal
	选择源颜色并忽略背景颜色。 更多...
	e_BlendOverlay = _fsdk.GraphicsObject_e_BlendOverlay
	根据背景颜色值进行相乘或滤色。 更多...
	e_BlendSaturation = _fsdk.GraphicsObject_e_BlendSaturation
	使用源颜色的饱和度和背景颜色的色调和明度创建颜色。 更多...
	e_BlendScreen = _fsdk.GraphicsObject_e_BlendScreen
	将背景的补码与源颜色值相乘，然后对结果取补。 更多...
	e_BlendSoftlight = _fsdk.GraphicsObject_e_BlendSoftlight
	根据源颜色值使颜色变暗或变亮。 更多...
	e_TypeAll = _fsdk.GraphicsObject_e_TypeAll
	表示所有图形对象类型，仅用作过滤器。
	e_TypeEmptyMarkedContent = _fsdk.GraphicsObject_e_TypeEmptyMarkedContent
	空标记内容对象。
	e_TypeFormXObject = _fsdk.GraphicsObject_e_TypeFormXObject
	表单XObject图形对象。
	e_TypeImage = _fsdk.GraphicsObject_e_TypeImage
	图像图形对象。
	e_TypeInlines = _fsdk.GraphicsObject_e_TypeInlines
	内联图形对象。
	e_TypePath = _fsdk.GraphicsObject_e_TypePath
	路径图形对象。
	e_TypeShading = _fsdk.GraphicsObject_e_TypeShading
	阴影图形对象。
	e_TypeText = _fsdk.GraphicsObject_e_TypeText
	文本图形对象。

详细描述

文本图形对象是一种PDF图形对象，因此TextObject 类派生自 GraphicsObject 类。它提供了获取/设置文本图形对象数据的函数。
要创建新的文本图形对象，请使用FoxitPDFSDKPython3.TextObject.Create 函数，然后 使用设置函数为新的文本图形对象设置信息。

参见

GraphicsObject

成员函数说明

Create()

FoxitPDFSDKPython3.TextObject.Create ( )

static

创建新的文本图形对象。

新创建的文本图形对象尚未包含任何数据。然后，可以调用设置函数 为新的文本图形对象设置数据。 如果新创建的文本图形对象不会插入到任何页面或其他对象中， 请记住在不使用时调用FoxitPDFSDKPython3.GraphicsObject.Release 函数来释放它。

返回

新的文本图形对象。如果有任何错误，此函数将返回null。

GetCharCount()

def FoxitPDFSDKPython3.TextObject.GetCharCount

(

)

获取当前文本对象中的字符数量。

返回

字符数量。

GetCharHeightByIndex()

def FoxitPDFSDKPython3.TextObject.GetCharHeightByIndex

(

index

)

获取当前文本对象中指定索引字符的高度。

参数

[in]

index

要检索其位置的字符索引。有效范围：从0到(count-1)。 count由FoxitPDFSDKPython3.TextObject.GetCharCount 函数返回。

返回

指定字符的高度。

GetCharPos()

def FoxitPDFSDKPython3.TextObject.GetCharPos

(

index

)

获取当前文本对象中指定索引字符的位置。

参数

[in]

index

要检索其位置的字符索引。有效范围：从0到(count-1)。 count由FoxitPDFSDKPython3.TextObject.GetCharCount 函数返回。

返回

指定字符的位置，在中。

GetCharWidthByIndex()

def FoxitPDFSDKPython3.TextObject.GetCharWidthByIndex

(

index

)

获取当前文本对象中指定索引字符的宽度。

参数

[in]

index

要检索其位置的字符索引。有效范围：从0到(count-1)。 count由FoxitPDFSDKPython3.TextObject.GetCharCount 函数返回。

返回

指定字符的宽度。

GetText()

def FoxitPDFSDKPython3.TextObject.GetText

(

)

获取文本字符串。

返回

文本字符串。

GetTextState()

def FoxitPDFSDKPython3.TextObject.GetTextState

(

page

)

获取文本状态信息。

参数

[in]

page

有效的PDF页面。请确保当前图形对象正好属于此页面。

返回

文本状态信息。

SetText()

def FoxitPDFSDKPython3.TextObject.SetText

(

text

)

设置文本字符串。

参数

[in]

text

新的文本字符串。

返回

无。

注解

在设置文本之前，请确保当前文本图形对象具有有效的字体， 该字体是文本状态的一部分。如果没有，请先调用FoxitPDFSDKPython3.TextObject.SetTextState 函数 设置有效字体；否则设置文本将失败。
当此函数成功时，应调用FoxitPDFSDKPython3.GraphicsObjects.GenerateContent 函数。 更多详细信息请参阅FoxitPDFSDKPython3.GraphicsObjects.GenerateContent 函数。

SetTextState()

def FoxitPDFSDKPython3.TextObject.SetTextState	(		page,
			text_state,
			is_italic,
			weight
	)

设置文本状态信息。

参数

[in]	page	有效的PDF页面。请确保当前图形对象正好属于此页面。
[in]	text_state	新的文本状态信息。
[in]	is_italic	true 表示当前图形对象的文本是斜体， false 表示不是。
[in]	weight	原始字体粗细。如果值大于500，表示使用粗体。

返回

无。

注解

当此函数成功时，应调用FoxitPDFSDKPython3.GraphicsObjects.GenerateContent 函数。 更多详细信息请参阅FoxitPDFSDKPython3.GraphicsObjects.GenerateContent 函数。